Deploying windmilldocs with    Cloudflare Pages

View logs

Claude finished @hcourdent's task in 3m 31s —— View job

Review

Summary

Adds 15 changelog entries (2026‑02‑25 → 2026‑03‑17) for features whose docs already existed but lacked a corresponding changelog, plus a small AGENTS.md update codifying the "frontmatter only, no body" rule for changelog index.md files (which is exactly what these new entries follow). Removes the temporary docs-gaps-2026-02-24-2026-04-13.md scratch file from the repo root.

Findings

No P0, P1, or P2 findings. Spot‑checks I ran:

• docs: link targets exist. All 15 entries point to real pages (e.g. docs/integrations/mssql.md, docs/misc/9_guides/otel/index.mdx, docs/advanced/11_git_sync/index.mdx).
• All anchors resolve. Verified each #fragment:
  • websocket_triggers#application-level-heartbeat → ### Application-level heartbeat (line 101) ✓
  • http_routing#workspace-prefix → ### Workspace prefix (line 93) ✓
  • otel#exporting-windmill-metrics-via-otlp → ## Exporting Windmill metrics via OTLP (line 229) ✓
  • otel#otel-trace-context-in-jobs → ## OTEL trace context in jobs (line 103) ✓
  • variables_and_secrets#secret-masking-in-job-logs → ## Secret masking in job logs (line 120) ✓
• Feature claims line up with the underlying docs. The OR/AND filter‑logic selector exists on both WebSocket and Kafka trigger pages; docs/core_concepts/2_variables_and_secrets/index.mdx#L132 matches the "8 character minimum" claim; docs/advanced/11_git_sync/index.mdx#L25 confirms Git Sync on CE for ≤2-user workspaces.
• Frontmatter shape is consistent. Every file has slug / title / tags / description / features / docs, no body content, sentence-case titles, and tags drawn from existing conventions (Self-hosted, Triggers, Enterprise, AI, Data tables, Workflows as code, Security, Resources).
• No duplicate changelog slugs. None of the 15 new entries collide with prior changelog directories.
• No em dashes in changelog descriptions (per the AGENTS.md rule). The two new em dashes added in the AGENTS.md diff itself match pre‑existing style in that file (it already contains 9 em dashes), so consistent in scope.
• Description length. Several descriptions exceed the 120–160 char target, but that is exactly what the same diff loosens to "one or two sentences" for changelog entries — so the new entries follow the new rule, not the old one. Worth being aware that AGENTS.md line 105 (the "120-160 characters for docs/changelog" guidance) and the updated line 107 are now slightly in tension; not a blocker for this PR but a future cleanup if you want them fully aligned.

Verification

• The diff is changelog frontmatter + one root file deletion + a small AGENTS.md text edit. No sidebars.js impact, no MDX, no React/JSX changes, no broken links spotted, so npm run build should pass.
• The deleted docs-gaps-2026-02-24-2026-04-13.md was at the repo root and isn't referenced anywhere in sidebars.js, docusaurus.config.js, or other doc pages — safe to remove.
• No in‑app surface to exercise beyond browsing the changelog index after deploy to confirm the new tiles render with the expected tag colours (Enterprise → blue link, others → blue badge).

• Read project guidance (AGENTS.md, writing_style_guide.md, REVIEW.md)
• Inspect each new changelog file for frontmatter, descriptions, tags
• Verify deletion of docs-gaps-2026-02-24-2026-04-13.md is intentional
• Self-validate findings; post review
  · branch changelogs_may_4

Claude finished @hcourdent's task in 1m 5s —— View job

Review (refreshed after merge from main)

No new findings. The PR diff against origin/main is unchanged from my prior review at a3f5b53 — same 17 files, same +198/-96 lines. The new commit (9dd1904) is a merge from main that brought in unrelated changes (e.g. ETL benchmark, blog posts) but did not add or modify anything in this PR's own scope. Re-running the diff confirms only the original additions: 15 changelog entries (2026‑02‑25 → 2026‑03‑17), the AGENTS.md "frontmatter only, no body" rule + relaxed description-length guidance, and the deletion of docs-gaps-2026-02-24-2026-04-13.md.

Findings

No P0, P1, or P2 findings. Full reasoning carried over from the prior review:

• docs: link targets exist. All 15 entries point to real pages (e.g. docs/integrations/mssql.md, docs/misc/9_guides/otel/index.mdx, docs/advanced/11_git_sync/index.mdx).
• All anchors resolve (websocket_triggers#application-level-heartbeat, http_routing#workspace-prefix, otel#exporting-windmill-metrics-via-otlp, otel#otel-trace-context-in-jobs, variables_and_secrets#secret-masking-in-job-logs all map to existing headings).
• Feature claims line up with the underlying docs (OR/AND filter logic on WebSocket + Kafka triggers; 8‑char minimum for variables; CE git sync for ≤2-user workspaces).
• Frontmatter shape is consistent. Every file has slug / title / tags / description / features / docs, no body content, sentence-case titles, tags drawn from existing conventions.
• No duplicate changelog slugs.
• No em dashes in changelog descriptions (per AGENTS.md). The two em dashes added in the AGENTS.md diff itself are consistent with that file's pre-existing style (it already contains 9).
• Description length. Several descriptions exceed the 120–160 char target, but that is exactly what the same diff loosens to "one or two sentences" for changelog entries — so the new entries follow the new rule. AGENTS.md line 105 (the "120-160 characters for docs/changelog" guidance) and the updated line 107 are now slightly in tension; not a blocker, but a future cleanup if you want them fully aligned.

Verification

• Diff is changelog frontmatter + one root-file deletion + a small AGENTS.md text edit. No sidebars.js impact, no MDX, no React/JSX changes — npm run build should pass (Cloudflare deploy already succeeded on a3f5b53).
• The deleted docs-gaps-2026-02-24-2026-04-13.md was at the repo root and isn't referenced from sidebars.js, docusaurus.config.js, or any doc page — safe to remove.
• No in‑app surface to exercise beyond browsing the changelog index after deploy to confirm the new tiles render with the expected tag colours.

• Confirm the diff vs origin/main is unchanged from prior review
• Re-validate prior findings still apply
• Post refreshed review

· branch changelogs_may_4 ·

@rubenfiszel can't merge, forever npm check

Claude finished @hcourdent's task in 1m 34s —— View job

Diagnosis: npm check is stuck because the workflow never triggered

The check docs build / npm_check job is a required status check on main, but the workflow's paths: filter in .github/workflows/build.yml is:

on:
  pull_request:
    types: [opened, synchronize, reopened, closed]
    paths:
      - 'src/**'
      - 'docs/**'
      - 'blog/**'

This PR only touches changelog/**, AGENTS.md, and a deleted root-level docs-gaps-...md. None of those paths match — so the workflow never runs, and the required check sits as "Expected — Waiting for status to be reported" indefinitely. That's the "forever npm check" you're seeing.

Fixes

Proper fix (needs @rubenfiszel — I can't touch .github/workflows/): add changelog/** to the paths filter so changelog-only PRs trigger the build too. Builds catch broken changelog frontmatter and the changelog index renders as part of the site, so it's a meaningful check.

paths:
  - 'src/**'
  - 'docs/**'
  - 'blog/**'
  - 'changelog/**'

Unblock-this-PR options (no workflow change required):

1. Admin-merge bypassing the required check (works for this PR, doesn't fix it for next time).
2. Push a trivial no-op change to any file under docs/** in this branch — that will trigger the workflow and let the check pass. Want me to do this? I'd suggest touching the description of one of the pages this PR's changelogs link to (e.g. tightening the description on docs/integrations/mssql.md) so it's not pure churn.

Let me know which route you want.

• Read CI status and identify failing/pending check
• Inspect .github/workflows/build.yml paths filter
• Confirm root cause (path filter excludes changelog/**)
• Apply chosen workaround once you confirm
  · branch changelogs_may_4